home *** CD-ROM | disk | FTP | other *** search
/ Shareware Overload Trio 2 / Shareware Overload Trio Volume 2 (Chestnut CD-ROM).ISO / dir24 / tn-x1jr2.zip / TN-X1J2.ZIP / CONFIGUR.TXT < prev    next >
Text File  |  1994-03-17  |  17KB  |  346 lines

  1.                       TheNet X-1J Release 2
  2.         
  3.                    Configuration instructions
  4.         
  5. 1. Introduction
  6.         
  7.      This  document  describes the build process for  creating  a 
  8.      ROM  image for TheNet X-1J release 2. This  process  differs 
  9.      from  the  previous  versions  of TheNet-X  in  that  it  is 
  10.      delivered  as  two  files  rather than  three.  This  is  in 
  11.      response  to a number of requests for a simpler process.  In 
  12.      addition  the  patcher  has been  considerably  changed  and 
  13.      utilities  for  hex conversion are included.  A  routine  to 
  14.      print out passwords in a 'user friendly' format is  included 
  15.      together  with  a  utility  to  change  the  help  text   in 
  16.      THENET2.X1J.
  17.      
  18.      BEWARE  !  The files carry the same names as TheNet  X-1J  ( 
  19.      original release ). Be sure to use the correct set of  files 
  20.      !.
  21.      
  22. 2.   Files.
  23.         
  24.           The ROM image comes as two files, 
  25.         
  26.                    THENET1.X1J
  27.                    THENET2.X1J
  28.         
  29.      These two files are loaded into memory as described below. 
  30.  
  31.      Before  loading them however, both should be  configured  as 
  32.      described in section 3.
  33.         
  34.      In addition, the following files are also provided :
  35.         
  36.                   PATCH.EXE
  37.                   INTEL.EXE
  38.                   MOTOROLA.EXE
  39.                   SETHELP.EXE
  40.                   PRINTPWD.EXE
  41.                   INTEL.C
  42.                   MOTOROLA.C
  43.                   SETHELP.C
  44.                   PRINTPWD.C
  45.  
  46.      PATCH.EXE is the windowing patch utility for the ROM images. 
  47.      INTEL.EXE  and MOTOROLA.EXE are utilities that are  designed 
  48.      to  convert  binary files into hex notation,  in  the  Intel 
  49.      Intellec  and Motorola S formats. SETHELP changes  the  help 
  50.      screen  and PRINTPWD does the pretty printing by  extracting 
  51.      the   password  from  a  parameter  save  file  created   by 
  52.      PATCH.EXE.
  53.      
  54.      The ROM image consists of two halves, one for the lower half 
  55.      of  a 512K EPROM, and one for the upper half. The files  are 
  56.      loaded as shown :
  57.         
  58.                    FILENAME           Load starting at hex
  59.                    =========================================
  60.                    THENET1.X1J        0000
  61.                    THENET2.X1J        8000
  62.  
  63.      No information on how to load the files into a programmer is 
  64.      presented  as  all  are  different.  Typical  scenarios  are 
  65.      however given in section 5.
  66.         
  67. 3. Configuration
  68.         
  69.      Each  of  the  two  halves of the  ROM  image  contains  two 
  70.      different  parts,  a  common  set  of  drivers  &  interrupt 
  71.      routines  and part of the functionality of the node. Part  1 
  72.      contains the level 2, 3 and 4 software. Part 2 contains  the 
  73.      switch. Each must be patched in an identical way to  reflect 
  74.      the  desired  operation as each part contains  an  identical 
  75.      section  at  the start of the file for  configuration  data. 
  76.      This  patching may be done manually or it may be  done  with 
  77.      the patcher.
  78.         
  79.      The first part of the ROM images is identical to TheNet 1.01 
  80.      in  its   configuration.  These  parameters  are    followed   
  81.      by additional ones for the extended version as shown :
  82.         
  83.      HEX    FIELD        
  84.      LOCN   SIZE      DESCRIPTION
  85.              
  86.      ===========================================================
  87.      003B   6 BYTES   CALLSIGN OF THE NODE
  88.      0041   BYTE      SSID OF THE NODE CALLSIGN
  89.      0042   6 BYTES   ALIAS OF THE NODE
  90.      004A   WORD      MIN AUTO UPDATE QUALITY
  91.      004C   WORD      HDLC DEFAULT ROUTE QUALITY
  92.      004E   WORD      DEFAULT RS232 ROUTE QUALITY
  93.      0050   WORD      INITIAL NODE LIFETIME
  94.      0052   WORD      MIN LIFETIME TO BROADCAST
  95.      0054   WORD      BROADCAST INTERVAL IN SECONDS
  96.      0056   WORD      LEVEL 3 TIME-TO-LIVE INITIALISER
  97.      0058   WORD      LEVEL 4 TIMEOUT IN SECONDS
  98.      005A   WORD      LEVEL 4 RETRIES
  99.      005E   WORD      LEVEL 4 ACK DELAY IN SECONDS
  100.      0060   WORD      LEVEL 4 WINDOW SIZE
  101.      0062   WORD      NUMBER OF BUFFERED FRAMES PER CONNECTION
  102.      0064   WORD      NO ACTIVITY TIMEOUT IN SECONDS
  103.      0066   WORD      PERSISTENCE
  104.      0068   WORD      SLOT TIME IN TENS OF MILLISECONDS
  105.      006A   WORD      LEVEL 2 INITIAL T1 COUNTER IN SECONDS
  106.      006C   WORD      LEVEL 2 WINDOW SIZE
  107.      006E   WORD      LEVEL 2 RETRIES
  108.      0070   WORD      LEVEL 2 INITIAL T2 COUNTER
  109.      0072   WORD      LEVEL 2 INITIAL T3 COUNTER
  110.      0074   WORD      LEVEL 2 DIGIPEAT ENABLE FLAG
  111.                       0 = DISABLED, 1 = ENABLED
  112.      0076   WORD      CALLSIGN VALIDATION, 0 = OFF, 1 = ON
  113.      0078   WORD      BEACON MODE, 0 = OFF, 1 = AFTER TRAFFIC,
  114.                       2 = ALWAYS
  115.      007A   WORD      CQ ENABLE FLAG, 0 = DISABLED, 1 = ENABLED
  116.      007C   BYTE      FULL DUPLEX FLAG, 0=SIMPLEX, 1 = DUPLEX
  117.      007D   BYTE      SEND FLAGS IF NO DATA NEEDED, 1 = YES
  118.      007E   BYTE      COMMAND LEAD-IN CHARACTER ( ESCAPE )
  119.      007F   BYTE      TRANSMIT KEY-UP DELAY, 10's OF MILLISECS
  120.      0080   80 BYTES  DEFAULT PASSWORD
  121.      00D0   BYTE      NULL BYTE AT END OF PASSWORD
  122.      00D1   80 BYTES  INFORMATION MESSAGE
  123.      0121   BYTE      NULL AT END OF INFORMATION STRING
  124.      0122   WORD      CW REPEAT RATE IN SECONDS. 0 DISABLES
  125.      0124   BYTE      CW BIT SPEED IN 10's OF MILLISECONDS
  126.                       6 = 20 WPM
  127.      0125   BYTE      DEFAULT HOST MODE. 0 = NORMAL
  128.                       1 = HARDWARE HANDSHAKE CONNECT CONTROL
  129.      0126   BYTE      CROSSLINK PROTOCOL MODE CONTROL
  130.                       0 = TheNet NORMAL CROSSLINK PROTOCOL
  131.                       1 = USE KISS INSTEAD OF CROSSLINK
  132.                       2 = AS PER 1, ALSO COPY NON NODE PKTS
  133.                       3 = AS PER 2 BUT COPY ALL PACKETS
  134.      0127   BYTE      MHEARD LIST LENGTH. 0 = OFF, MAX = 100      
  135.      0128   BYTE      NODE BROADCAST CONTROL. 0 = NO BCAST
  136.                       1 = HDLC PORT ONLY, 2 = RS232 PORT ONLY
  137.                       3 = BOTH PORTS
  138.      0129   WORD      RS232 NODE BROADCAST INTERVAL ( SECS )
  139.                       0 DISABLES
  140.      012B   BYTE      NODE BROADCAST ALGORITHM CONTROL.
  141.                       BIT 0 = HDLC, BIT 1 = RS232
  142.                       WHEN BIT SET, IMPLEMENT VARIANT ALGO. 
  143.      012C   8 BYTES   OPTIONAL BEACON DIGI LIST, NULL TERM.
  144.      0134   WORD      DEFAULT BEACON INTERVAL IN SECONDS
  145.      0136   BYTE      CONNECT REDIRECTION, 0=HOST 1=BBS 2=DXC
  146.      0137   BYTE      HASH NODE CONTROL. Each  bit  controls 
  147.                       whether nodes whose alias starts with a '#' 
  148.                       are  included  in  node  broadcasts  on   a 
  149.                       specific  port. Bit 0 determines port  0  ( 
  150.                       the radio ), bit 1 controls the RS232 port. 
  151.                       If  a  bit  is  set,  hash  nodes  are  not 
  152.                       broadcast.
  153.      0138   4 BYTES   THIS IS THE NODE'S AMPRNET ADDRESS. 
  154.                       It  is a numeric address of 4  bytes.  Each 
  155.                       byte   corresponds  to  one  byte  of   the 
  156.                       address,  for  example if  the  address  is 
  157.                       44.131.16.31, then the data stored at  each 
  158.                       of   the  bytes  138,  139,  13A  and   13B 
  159.                       respectively  will  be 1F, 10, 83  and  2C. 
  160.                       Contact  your  local  co-ordinator  for  an 
  161.                       address.
  162.      013C   4 BYTES   THIS  IS  THE AMPRNET ADDRESS USED  BY  THE 
  163.                       NODE  TO RECOGNISE BROADCASTS. The data  is 
  164.                       stored  in the same way as for  the  node's 
  165.                       address  (  as  shown above  ).  A  typical 
  166.                       address would be 44.131.0.0 for the UK.
  167.      0140   BYTE      IP PORT MODE CONTROL. 
  168.                       This  byte controls the default modes  used 
  169.                       for  AX.25 frames on each port. It  is  bit 
  170.                       mapped,  with bit 0 controlling  the  radio 
  171.                       port and bit 1 controlling the RS232  port. 
  172.                       If a bit is set, the default mode for  that 
  173.                       channel  is datagram ( UI frame ),  if  not  
  174.                       it is virtual circuit.
  175.      0141   BYTE      IP INITIAL TIME TO LIVE
  176.      0142   BYTE      IP ENABLE FLAG. 
  177.                       If zero, the IP router is disabled. 
  178.                       If not zero the IP router is operational.
  179.      0143   BYTE      HELP MESSAGES CONTROL BYTE. 
  180.                       Each  bit enables or disables  a  different 
  181.                       type of help message as follows :
  182.                       
  183.                       Bit 0 - 'trying to connect' message
  184.                       Bit 1 - sysop sees all commands in help
  185.                       Bit 2 - give a 'good-bye' message to users
  186.                       Bit 3 - enables the connect text message
  187.                       Bit 4 - show nodes as alias:callsign
  188.                       Bit 5 - pass 8 bit data in TALK if set
  189.                       Bit 6 - Make node alias handling case sensitive
  190.                       Bit 7 - Enable TexNet interface handler
  191.      0144   WORD      MTU_IP0
  192.                       This is the MTU for port 0 Level 2 AX.25  ( 
  193.                       the radio port ) for the IP router.
  194.      0146   WORD      MTU_IP1
  195.                       This is the MTU for port 1 Level 2 AX.25  ( 
  196.                       the RS232 port ) for the IP router.
  197.      0148   WORD      MTU_IPN
  198.                       This is the MTU for the Net/Rom  subnetwork 
  199.                       layer.   It  should  NOT  exceed  236   for 
  200.                       compatibility with Net/Rom
  201.      014A   WORD      MTU_I_MAX
  202.                       This  is the maximum number of data  bytes, 
  203.                       plus  one,  that  will  be  accepted  in  a 
  204.                       received  L2 AX.25 packet. Above this  will 
  205.                       cause an error.
  206.      014C   WORD      MTU_L2_MAX
  207.                       This is the absolute limit on the number of 
  208.                       bytes in a received AX.25 packet,  counting 
  209.                       the data, control, and address information. 
  210.                       It is set to 328 usually ( 256 data  bytes, 
  211.                       2 control and 70 address ).
  212.      014E   BYTE      Auto reconnect to node on remote dis if 1
  213.      014F   BYTE      NoSlime - 
  214.                       Bit  0, if set, stops 'slime trails'  being 
  215.                       displayed  in  the nodes table. Bit  1,  if 
  216.                       set,  stops slime trails being accepted  by 
  217.                       the node.
  218.      0150   BYTE      Bit  0 if set bars digi L2 connects to  the 
  219.                       node. 
  220.                       Bit  1 if set bars digi downlinks from  the 
  221.                       node.
  222.      0151   BYTE      DEVIATION METER DEFAULT.
  223.                       This  is  the  default  value  for  the  RX 
  224.                       Deviation meter.
  225.      0152   WORD      METER  FLAGS.  Each bit  controls  a  meter 
  226.                       function
  227.      0154   BYTE      S  METER SIGNAL MINIMUM This  parameter  is 
  228.                       the ADC noise floor reading ( 0 to 255 )
  229.      0155   BYTE      S METER MULTIPLIER This is used to scale
  230.                       readings to give the S1-S9 style display
  231.      0156   BYTE      DBM  MULTIPLIER  This  is  used  to   scale 
  232.                       readings to give the dBm style display
  233.      0157   BYTE      DBM NOISE FLOOR This is the reading that
  234.                       corresponds to no signal on calibration
  235.      0158   BYTE      This  is  the voltmeter channel  1  scaling 
  236.                       factor
  237.      0159   BYTE      This  is  the voltmeter channel  2  scaling 
  238.                       factor
  239.      015A   BYTE      This  is  the voltmeter  channel  1  offset 
  240.                       value
  241.      015B   BYTE      This  is  the voltmeter  channel  2  offset 
  242.                       value
  243.         
  244.         
  245.      The patch utility will not assist in changing the help text. 
  246.      That  text is positioned at the end of THENET2.X1J. It is  a 
  247.      null   terminated   string  of  characters.   Newlines   are 
  248.      represented  by the value 0xd ( decimal 13 ). It can  be  as 
  249.      long  or  as  short as you like, but don't  forget  that  it 
  250.      causes  the  node to be a source of data and  if  very  long 
  251.      could crash the node. ( Not likely in this version given the 
  252.      space  available!). The easiest way to change it is  to  use 
  253.      the SETHELP utility.
  254.      
  255.      Any problems, give me a ring !
  256.      
  257. 4. The PATCH utility
  258.         
  259.      The patch utility is designed to help configure the two  ROM 
  260.      images  in  a  manner that is not as user  hostile  as  hand 
  261.      crafting a binary image. It is invoked as follows :
  262.         
  263.                   PATCH   [  file1 file2 ]
  264.  
  265.      If  no  parameters  are  given,  it  will  look  for   files 
  266.      THENET1.X1J  and  THENET2.X1J in the current  directory.  It 
  267.      will stop if it cannot load them. If the images are renamed, 
  268.      they may be given as parameters. If this is done, both files 
  269.      must be given, with file1 corresponding to part 1 and  file2 
  270.      corresponding  to part 2. The program is menu  driven,  with 
  271.      extensive help provided on the operation of the program  and 
  272.      each  parameter. It also tries to make sure that only  valid 
  273.      data is entered.
  274.      
  275.      The program may also be instructed to load and save  textual 
  276.      representations  of the parameters. These consist  of  ASCII 
  277.      files, with one parameter per line. Each parameter  consists 
  278.      of the name of the parameter, and equals sign, and the value 
  279.      for that parameter. The values are mainly numeric, with  the 
  280.      obvious  exceptions  of  things like  the  callsign,  alias, 
  281.      password, info message etc. To get an example of the format, 
  282.      use  the patcher to dump a file and look at it. The idea  of 
  283.      this  is  not simply to load and dump whole images,  but  to 
  284.      load  partial  configurations  such  as  passwords  &   info 
  285.      messages only or parameters only. The file may be edited  to 
  286.      remove  or  add lines as desired. Note that  each  parameter 
  287.      MUST  only  occupy one line. For  the  information  message, 
  288.      whitespace  before the first printable character is  ignored 
  289.      by  the program, and if a newline is to be included,  it  is 
  290.      denoted by the sequence \m ( i.e. backslash followed by  the 
  291.      letter  m ). Similarly, to include the  backslash  character 
  292.      itself, a double backslash must be entered, i.e. \\.
  293.      
  294. 5. Programming examples
  295.         
  296.      There are two utilities included to facilitate conversion to 
  297.      hex  for  use in programming eproms. The source of  both  is 
  298.      also  included  if anyone wants a different file  type.  The 
  299.      programs have been compiled with Turbo C++.
  300.      
  301.      Each has the same method of invocation,
  302.      
  303.                   INTEL infile outfile [ address ]
  304.  
  305.      or
  306.         
  307.                   MOTOROLA infile outfile [ address ]
  308.  
  309.      These create INTELLEC or S1 type records respectively.  Each 
  310.      reads  an input binary file and outputs a hex  version.  The 
  311.      starting  address assumed for the file will be  0000  unless 
  312.      specified otherwise in the command line.
  313.         
  314. 5.1 Intel format, loading as two halves
  315.         
  316.      1. Use the patch program to create the desired image.
  317.      2. execute :
  318.  
  319.                   INTEL TheNet1.x1j part1
  320.                   INTEL TheNet2.x1j part2
  321.  
  322.      3. load part1 into the programmer and program the lower half 
  323.         of the ROM. Load part2 into the upper half.
  324.         
  325. 5.2 Motorola format, loading as one image
  326.         
  327.      1. Use the patch program to create the desired image.
  328.      2. Execute :
  329.  
  330.                   MOTOROLA TheNet1.x1j part1
  331.                   MOTOROLA TheNet2.x1j part2 8000
  332.                   COPY part1+part2 romimage
  333.              
  334.      3. Edit   romimage  with  a  text  editor  to   remove   the 
  335.         intermediate end of file ( S0... ) marker.
  336.      4. Load romimage into the EPROM in one go & program it.
  337.         
  338. 6. Acknowledgements
  339.      
  340.      Intel and Intellec are trademarks of the Intel corporation
  341.      Motorola is a trade mark of the Motorola company.
  342.      
  343.      My  thanks to KH6ILT for the bug fixes to MOTOROLA.C and  to 
  344.      John  Bednar  WB3ESS for the SETHELP  utility  (  originally 
  345.      named HELPX1J ).
  346.